Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #12

wants to merge 1 commit into from

Conversation

3raxton
Copy link

@3raxton 3raxton commented Nov 17, 2024

I updated the README.md file to be easier to follow, read, and understand. I was struggling to follow all of the instructions and figured a breakdown may help make things a bit easier for other people coming to this repo in the future. Thanks for building this!

Make README.md easier to follow, read, and understand
@aidandenlinger
Copy link
Owner

Thanks for the PR! I appreciate someone bringing a fresh set of eyes to the documentation and ironing out any rough spots, I'm guilty of writing excessively long instructions :)

There's a few practice I like to follow with my READMEs, mainly following the Standard README specification and trying to stick with basic Markdown instead of Github's added Markdown features so it looks nice everywhere. Because of this, I'm a bit finicky with the headings and sections. This PR uses headings to make topics more bolded and emphasized when reading, but it also makes the table of contents harder to follow:

main's Table of Contents this PR's Table of Contents
Screenshot From 2024-11-16 19-38-59 Screenshot From 2024-11-16 19-36-02

So I don't plan on merging this PR directly, but I plan on integrating the content and emphasis suggestions from this PR in a new commit when I touch up the README. I also plan on integrating improvements after my discussions in #7 (with you) and #11 help me see other blind or weak spots in the documentation.

Again, thanks for this feedback, it's super useful! It's greatly appreciated (and you'll be in the Thanks section when I touch up the README :) )

@3raxton
Copy link
Author

3raxton commented Nov 17, 2024

Sure thing, I struggled a ton to follow the layout of the README so I made it a bit more digestible. I hope this helps and look forward to what you end up adding! Thanks for the great work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants